-
Notifications
You must be signed in to change notification settings - Fork 5k
docs: fix connector config field names in hosted tutorial #72392
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
docs: fix connector config field names in hosted tutorial #72392
Conversation
Co-Authored-By: ian.alton@airbyte.io <ian.alton@airbyte.io>
🤖 Devin AI EngineerI'll be helping with this pull request! Here's what you should know: ✅ I will automatically:
Note: I can only respond to comments from users who have write access to this repository. ⚙️ Control Options:
|
👋 Greetings, Airbyte Team Member!Here are some helpful tips and reminders for your convenience. 💡 Show Tips and TricksPR Slash CommandsAirbyte Maintainers (that's you!) can execute the following slash commands on your PR:
📚 Show Repo GuidanceHelpful Resources
|
|
Deploy preview for airbyte-docs ready! ✅ Preview Built with commit d8996d8. |
…r config Co-Authored-By: ian.alton@airbyte.io <ian.alton@airbyte.io>
| - `environment`: Connector-specific configurations for replication connectors. | ||
| - `environment`: Connector-specific configurations for the connector. | ||
|
|
||
| - `replication_config`: Optional replication-specific settings like `start_date`, `lookback_window`, etc. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We can omit this line, since this connector doesn't use it.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Done - removed the replication_config line.
Co-Authored-By: ian.alton@airbyte.io <ian.alton@airbyte.io>
What
Fixes incorrect field names in the hosted agent connectors tutorial. The API expects
environmentfor connector-specific configurations (likerepositoriesfor GitHub) andcredentialsfor authentication, but the documentation showedsource_config, causing 422 errors for users following the tutorial.How
Updated the field names and descriptions in
docs/ai-agents/quickstarts/tutorial-hosted.md:source_configtoenvironmentin the example curl requestsource_configfield descriptioncredentialsandenvironmentReview guide
docs/ai-agents/quickstarts/tutorial-hosted.md- verify the field names match the actual API schema for/api/v1/integrations/connectorsHuman review checklist
environmentis the correct field for GitHub'srepositoriesconfigUser Impact
Users following this tutorial will now be able to successfully create connectors without receiving 422 validation errors.
Can this PR be safely reverted and rolled back?
Requested by: ian-at-airbyte
Link to Devin run: https://app.devin.ai/sessions/aa62f13a945a42458b067a9c2c7ffbc5
Important
Auto-merge enabled.
This PR is set to merge automatically when all requirements are met.